/**
 * Copyright 2006 gworks.com.au
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License. (http://www.apache.org/licenses/LICENSE-2.0)
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed 
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for 
 * the specific language governing permissions and limitations under the License.
 *
 * <dhamma-message src="Atisha (11th century Tibetan Buddhist master)">
 * 	The greatest achievement is selflessness. The greatest worth is self-mastery.
 * 	The greatest quality is seeking to serve others. The greatest precept is continual awareness.
 * 	The greatest medicine is the emptiness of everything. The greatest action is not conforming with the worlds ways.
 * 	The greatest magic is transmuting the passions. The greatest generosity is non-attachment.
 * 	The greatest goodness is a peaceful mind. The greatest patience is humility.
 * 	The greatest effort is not concerned with results. The greatest meditation is a mind that lets go.
 * 	The greatest wisdom is seeing through appearances. 
 * </dhamma-message>
 */
package org.javaongems.client.rt.io;

/**
 * <p>Provide emulation valid path class utilities.</p>
 * <p>Responsbilities:
 * <ul>
 * 	<li> append, prepend and remove slashs from paths
 * </ul>
 * </p>
 * 
 * @author Ashin Wimalajeewa (ash)
 */
final public class PathUtils {
	final static public char FORWARD_SLASH_CHAR = '/';
	final static public String FORWARD_SLASH = FORWARD_SLASH_CHAR + "";
	
	private PathUtils() {
    	// nothing to do.
	}

	static public String appendSlashIfRequired(String path) {
		if (path.endsWith(FORWARD_SLASH))
			return path;
		return path + FORWARD_SLASH;
	}
	
	static public String prependSlashIfRequired(String path) {
		if (path.startsWith(FORWARD_SLASH))
			return path.substring(1);
		return path;
	}
	
	static public String removeSlashIfRequired(String path, boolean prefix, boolean ignoreIfRoot) {
		int len = path.length();
		boolean ignore = (ignoreIfRoot && len == 1);
		if (prefix) {
			if (path.startsWith(FORWARD_SLASH) && !ignore) 
				path = path.substring(1);
		} else {
			if (path.endsWith(FORWARD_SLASH) && !ignore)
				path = path.substring(0, len - 1);
		}
		return path;
	}
}